本文档汇总各模型共享的通用请求与响应字段,便于复用与查阅。模型特有字段请参考各自的
字段名 | 字段类型 | 是否必传 | 字段默认值 | 字段说明 |
|---|---|---|---|---|
| model | string | 否 | 当前实例模型名 | 模型名称;SDK 一般会自动设置为当前实例的 modelName |
| messages | Array<{ role: "system"|"user"|"assistant"; content: string | Array | 是 | - | 对话消息数组,支持多轮;多模态模型中 content 可为数组 |
| messages.role | "system" | "user" | "assistant" | 是 | - | 消息角色:系统/用户/助手 |
| messages.content | string | Array | 是 | - | 文本或多模态内容;见下文 ContentPart 定义 |
| parameters | object | 否 | - | 各模型的参数对象(采样配置/功能开关等),常见字段见下一节 |
类型名 | 结构 | 说明 |
|---|---|---|
| Text | { type: "text"; text: string } | 纯文本片段 |
| ImageUrl | { type: "image_url"; image_url: { url: string; detail?: "auto"|"low"|"high" } } | 图片 URL 片段 |
| DocUrl | { type: "doc_url"; doc_url: string | string[] } | 文档 URL 片段(PDF/图片等) |
提示:部分模型要求
字段名 | 字段类型 | 是否必传 | 字段默认值 | 字段说明 |
|---|---|---|---|---|
| temperature | number | 否 | 1.0 | 生成随机性,范围 0, 2,值越高越随机 |
| top_p | number | 否 | 1.0 | 核采样阈值,范围 0, 1 |
| max_tokens | number | 否 | 1000/2000(视模型) | 最大生成 token 数 |
| n | number | 否 | 1 | 生成数量上限(部分模型固定为 1) |
| stream | boolean | 否 | false/true(视模型) | 是否以流式返回(文本模型常用) |
| stop | string | string | 否 | - | 停止词,命中后终止生成 |
| frequency_penalty | number | 否 | 0.0 | 字符重复惩罚,范围 -2, 2 |
| presence_penalty | number | 否 | 0.0 | 主题重复惩罚,范围 -2, 2 |
| user | string | 否 | - | 用户标识(≤64 字符),用于审计/追踪 |
| enable_search | boolean | 否 | false | 是否开启联网搜索(部分模型支持) |
| enable_thinking | boolean | 否 | false | 是否开启思考模式(部分模型支持) |
说明:图像/风格类模型还会有各自的专属字段(如
不同供应商接口形态略有差异,但常见结构如下:
字段名 | 字段类型 | 是否必传 | 字段默认值 | 字段说明 |
|---|---|---|---|---|
| model | string | 是 | 各模型名 | 模型名称(如 qwen-image 、qwen-doc-turbo 等) |
| input | object | 是 | - | 输入主体,通常包含 messages 或任务相关字段(如 prompt 、sketch_image_url 等) |
| parameters | object | 否 | - | 参数对象,同“通用参数”与各模型专属字段 |
SDK 会将各模型响应标准化为统一结构,便于上层调用。
字段名 | 字段类型 | 是否必传 | 字段默认值 | 字段说明 |
|---|---|---|---|---|
| id | string | 否 | - | 请求/响应 ID |
| object | string | 否 | chat.completion | 对象类型 |
| created | number | 否 | - | 时间戳(秒) |
| model | string | 否 | - | 实际使用的模型名 |
| log_id | string | 否 | - | 日志/追踪 ID |
| error | string | 否 | "" | 错误信息 |
| code | number | 否 | 0 | 错误码 |
| choices | Array<{ index: number; message: { id: string; role: "assistant"|"user"; type: string; content: string; reasoning_content: string }; finish_reason: string }> | 否 | - | 结果列表:文本类 type=answer ;图片类 type=image ;异步任务 type=async_task |
| usage | { prompt_tokens: number; completion_tokens: number; knowledge_tokens: number; reasoning_tokens: number; total_tokens: number } | 否 | - | Token 统计(部分供应商可能缺失) |
字段名 | 字段类型 | 是否必传 | 字段默认值 | 字段说明 |
|---|---|---|---|---|
| id | string | 否 | - | 片段 ID(通常沿用请求 ID) |
| object | string | 否 | chat.completion.chunk | 流片段对象类型 |
| created | number | 否 | - | 时间戳(秒) |
| model | string | 否 | - | 模型名 |
| log_id | string | 否 | - | 日志/追踪 ID |
| error | string | 否 | "" | 错误信息 |
| code | number | 否 | 0 | 错误码 |
| choices | Array<{ index: number; message: { id: string; role: "assistant"; type: string; content: string; reasoning_content: string }; finish_reason: string|null }> | 否 | - | 增量内容:文本类逐字输出;非流式模型通常包装为单帧 |
| usage | 同上 | 否 | - | 一般在最后一个片段返回 |